Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adding a "packaging flow" overview document #1100

Merged
merged 33 commits into from Jul 28, 2022

Conversation

cameron-simpson
Copy link
Contributor

Per @pfmoore 's suggestion here:
https://discuss.python.org/t/adding-a-packaging-flow-overview-to-the-pypa-docs/15060/3?u=cameron

this pull request offers a document providing a conceptual overview of the PyPA package publishing flow, proposal here:
https://discuss.python.org/t/adding-a-packaging-flow-overview-to-the-pypa-docs/15060

I came to write this after writing this post: https://discuss.python.org/t/modernising-my-packages-am-i-thinking-about-this-all-wrong/14558?u=cameron where I described the problems I had trying to figure out how to move to a more modern pyproject.toml based system for my packages, largely because I became swamped in a sea of detailed documents which I could not string together; the PEPs in particular are written for people already very familiar with the packaging ecosystem.

This document is (a) not a tutorial and (b) not a "how to". Its purpose is to outline the required high level semantic steps involved in publishing a package, showing the flow from the author to (typically) PyPI and then on to the end user.

It has had some mostly positive feedback in the linked discussions which I've tried to take onboard.

Copy link
Contributor

@abravalheri abravalheri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you very much @cameron-simpson!

source/flow.rst Outdated Show resolved Hide resolved
source/flow.rst Outdated Show resolved Hide resolved
source/flow.rst Outdated Show resolved Hide resolved
source/flow.rst Outdated Show resolved Hide resolved
source/flow.rst Outdated Show resolved Hide resolved
@cameron-simpson
Copy link
Contributor Author

@pfmoore @abravalheri if we're broadly happy with this PR as it is now, whom should I petition to get it merged?

@pfmoore
Copy link
Member

pfmoore commented Jul 8, 2022

Sorry, I don't know who the maintainers of packaging.python.org are.

@bhrutledge bhrutledge self-requested a review July 8, 2022 13:07
@bhrutledge
Copy link
Contributor

I can merge this after reviewing it (probably this weekend), or @webknjaz can do it if he approves.

@cameron-simpson
Copy link
Contributor Author

cameron-simpson commented Jul 18, 2022

I can merge this after reviewing it (probably this weekend), or @webknjaz can do it if he approves.

Just a quiet ping, in case this fell off your radar. Thanks, Cameron

@bhrutledge
Copy link
Contributor

Yep, thanks for the ping. It's on my radar every day, but life has been exceedingly busy, and will continue to be through at least this weekend.

@cameron-simpson
Copy link
Contributor Author

cameron-simpson commented Jul 19, 2022 via email

Copy link
Contributor

@bhrutledge bhrutledge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just pushed a bunch of edits that I think streamline the description of the flow, while maintaining its overall structure. A number of changes are basic copy-editing for consistency of language. I also removed content that felt overly-specific and/or redundant. The biggest change is probably condensing the build-system description. Finally, I left a number of TODOs that can be addressed in this PR, or in follow-ups.

If y'all are content with the changes, I'm happy to merge this.

@bhrutledge bhrutledge requested a review from webknjaz July 21, 2022 15:16
@bhrutledge
Copy link
Contributor

@cameron-simpson My turn for a quiet ping. 😉

@cameron-simpson
Copy link
Contributor Author

@cameron-simpson My turn for a quiet ping. 😉

I've covered off everything except the final TODO about mentioning virtual environments and tools like poetry etc. I'm still a bit reluctant to introduce this in a conceptual explaination like this one, which already feels like it is getting wordy. And I haven't figured out what I would write here anyway.

Copy link
Contributor

@bhrutledge bhrutledge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cameron-simpson Thanks for the updates. I want to make some more to polish it up; I'm aiming to do that in the next few days.

@cameron-simpson
Copy link
Contributor Author

cameron-simpson commented Jul 27, 2022 via email

Copy link
Contributor

@bhrutledge bhrutledge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cameron-simpson I just pushed my edits. The biggest changes are in the "configuration file" and "built distributions" sections. What do you think?

source/flow.rst Outdated Show resolved Hide resolved
@cameron-simpson
Copy link
Contributor Author

cameron-simpson commented Jul 28, 2022 via email

@cameron-simpson
Copy link
Contributor Author

cameron-simpson commented Jul 28, 2022 via email

@bhrutledge bhrutledge merged commit 5734dde into pypa:main Jul 28, 2022
@cameron-simpson
Copy link
Contributor Author

cameron-simpson commented Jul 28, 2022 via email

@bhrutledge
Copy link
Contributor

Thank you for the PR!

@cameron-simpson
Copy link
Contributor Author

cameron-simpson commented Oct 11, 2022 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants